kanzi::KeyframeAnimation< TValueType >::StepKeyframe Class Reference

Use Step keyframes to keep the value of the current keyframe constant up until the following keyframe. More...

#include <kanzi/core.ui/animation/keyframe_animation.hpp>

Inheritance diagram for kanzi::KeyframeAnimation< TValueType >::StepKeyframe:

Public Member Functions
TValueType	getValue (const TValueType &currentValue, float normalizedTime) override
	Returns the value for the animated property at a given time. More...
	StepKeyframe ()
	Constructor. More...
	StepKeyframe (TValueType value)
	Constructor. More...
Public Member Functions inherited from kanzi::KeyframeAnimation< TValueType >::Keyframe
TValueType	getKeyValue () const
	Returns the keyframe value of the animated property. More...
	Keyframe ()
	Constructor. More...
	Keyframe (TValueType value)
	Constructor. More...
void	setKeyValue (const TValueType &keyValue)
	Sets the keyframe value for a keyframe. More...
virtual	~Keyframe ()

Static Public Member Functions
static StepKeyframePtr	create (float value)
	Creates a step keyframe. More...

Detailed Description

template<typename TValueType>
class kanzi::KeyframeAnimation< TValueType >::StepKeyframe

Use Step keyframes to keep the value of the current keyframe constant up until the following keyframe.

Constructor & Destructor Documentation

template<typename TValueType >

kanzi::KeyframeAnimation< TValueType >::StepKeyframe::StepKeyframe ( )

inlineexplicit

Constructor.

template<typename TValueType >

kanzi::KeyframeAnimation< TValueType >::StepKeyframe::StepKeyframe ( TValueType  value )

inlineexplicit

Constructor.

Parameters

value

The keyframe value of the animated property.

Member Function Documentation

template<typename TValueType >

static StepKeyframePtr kanzi::KeyframeAnimation< TValueType >::StepKeyframe::create ( float  value )

inlinestatic

Creates a step keyframe.

Parameters

value

The keyframe value of the animated property.

template<typename TValueType >

TValueType kanzi::KeyframeAnimation< TValueType >::StepKeyframe::getValue ( const TValueType &  currentValue, float  normalizedTime  )

inlineoverridevirtual

Returns the value for the animated property at a given time.

Parameters

currentValue	The current value of the animated property.
normalizedTime	The time at which you want to get the value of the animated property. 0.0 corresponds to the time of the previous keyframe. 1.0 corresponds to the time of this keyframe.

Returns

The value of the animated property at a given time.

Implements kanzi::KeyframeAnimation< TValueType >::Keyframe.

---

The documentation for this class was generated from the following file:

• kanzi/core.ui/animation/keyframe_animation.hpp